sourceview.GutterRendererText source code

1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module sourceview.GutterRendererText;
26 
27 private import glib.ConstructionException;
28 private import glib.Str;
29 private import gobject.ObjectG;
30 private import sourceview.GutterRenderer;
31 private import sourceview.c.functions;
32 public  import sourceview.c.types;
33 
34 
35 /**
36  * Renders text in the gutter.
37  * 
38  * A `GtkSourceGutterRendererText` can be used to render text in a cell of
39  * [class@Gutter].
40  */
41 public class GutterRendererText : GutterRenderer
42 {
43 	/** the main Gtk struct */
44 	protected GtkSourceGutterRendererText* gtkSourceGutterRendererText;
45 
46 	/** Get the main Gtk struct */
47 	public GtkSourceGutterRendererText* getGutterRendererTextStruct(bool transferOwnership = false)
48 	{
49 		if (transferOwnership)
50 			ownedRef = false;
51 		return gtkSourceGutterRendererText;
52 	}
53 
54 	/** the main Gtk struct as a void* */
55 	protected override void* getStruct()
56 	{
57 		return cast(void*)gtkSourceGutterRendererText;
58 	}
59 
60 	/**
61 	 * Sets our main struct and passes it to the parent class.
62 	 */
63 	public this (GtkSourceGutterRendererText* gtkSourceGutterRendererText, bool ownedRef = false)
64 	{
65 		this.gtkSourceGutterRendererText = gtkSourceGutterRendererText;
66 		super(cast(GtkSourceGutterRenderer*)gtkSourceGutterRendererText, ownedRef);
67 	}
68 
69 
70 	/** */
71 	public static GType getType()
72 	{
73 		return gtk_source_gutter_renderer_text_get_type();
74 	}
75 
76 	/**
77 	 * Create a new #GtkSourceGutterRendererText.
78 	 *
79 	 * Returns: A #GtkSourceGutterRenderer
80 	 *
81 	 * Throws: ConstructionException GTK+ fails to create the object.
82 	 */
83 	public this()
84 	{
85 		auto __p = gtk_source_gutter_renderer_text_new();
86 
87 		if(__p is null)
88 		{
89 			throw new ConstructionException("null returned by new");
90 		}
91 
92 		this(cast(GtkSourceGutterRendererText*) __p, true);
93 	}
94 
95 	/**
96 	 * Measures the text provided using the pango layout used by the
97 	 * #GtkSourceGutterRendererText.
98 	 *
99 	 * Params:
100 	 *     text = the text to measure.
101 	 *     width = location to store the width of the text in pixels,
102 	 *         or %NULL.
103 	 *     height = location to store the height of the text in
104 	 *         pixels, or %NULL.
105 	 */
106 	public void measure(string text, out int width, out int height)
107 	{
108 		gtk_source_gutter_renderer_text_measure(gtkSourceGutterRendererText, Str.toStringz(text), &width, &height);
109 	}
110 
111 	/**
112 	 * Measures the pango markup provided using the pango layout used by the
113 	 * #GtkSourceGutterRendererText.
114 	 *
115 	 * Params:
116 	 *     markup = the pango markup to measure.
117 	 *     width = location to store the width of the text in pixels,
118 	 *         or %NULL.
119 	 *     height = location to store the height of the text in
120 	 *         pixels, or %NULL.
121 	 */
122 	public void measureMarkup(string markup, out int width, out int height)
123 	{
124 		gtk_source_gutter_renderer_text_measure_markup(gtkSourceGutterRendererText, Str.toStringz(markup), &width, &height);
125 	}
126 
127 	/** */
128 	public void setMarkup(string markup, int length)
129 	{
130 		gtk_source_gutter_renderer_text_set_markup(gtkSourceGutterRendererText, Str.toStringz(markup), length);
131 	}
132 
133 	/** */
134 	public void setText(string text, int length)
135 	{
136 		gtk_source_gutter_renderer_text_set_text(gtkSourceGutterRendererText, Str.toStringz(text), length);
137 	}
138 }